home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / il / ilPage.z / ilPage
Encoding:
Text File  |  2002-10-03  |  4.0 KB  |  133 lines
  1.  
  2.  
  3.  
  4. iiiillllPPPPaaaaggggeeee((((3333))))          IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll          iiiillllPPPPaaaaggggeeee((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiillllPPPPaaaaggggeeee - class that implements an image page descriptor.
  10.  
  11.  
  12. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  13.      iflXYZCint
  14.  
  15.  
  16. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  17.      #include <il/ilPage.h>
  18.  
  19.  
  20. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  21.      This class implements an image page descriptor. It is further derived by
  22.      ilCacheImg as the base for a more complete page descriptor.
  23.  
  24.      It contains the page-starting image coordinates and a pointer to the data
  25.      buffer where the page is stored.
  26.  
  27. CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
  28.      CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr
  29.  
  30.           ilPage(int x, int y, int z, int c, void* Data=NULL)
  31.  
  32.      AAAAttttttttrrrriiiibbbbuuuutttteeee aaaacccccccceeeessssssss ffffuuuunnnnccccttttiiiioooonnnnssss
  33.  
  34.           int matches(int x, int y, int z, int c)
  35.           void getPos(int& x, int& y, int& z, int& c)
  36.           void* getData()
  37.           void setPID()
  38.           pid_t getPID()
  39.  
  40.  
  41.  
  42. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  43.      iiiillllPPPPaaaaggggeeee(((())))
  44.  
  45.           ilPage(int x, int y, int z, int c, void* data=NULL)
  46.  
  47.  
  48.           The constructor creates a page with coordinates, _x, _y, _z, _c, whose
  49.           data buffer points to _d_a_t_a.
  50.  
  51.      ggggeeeettttDDDDaaaattttaaaa(((())))
  52.  
  53.           void* getData()
  54.  
  55.  
  56.           This method returns the pointer to the data buffer where the page is
  57.           stored.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. iiiillllPPPPaaaaggggeeee((((3333))))          IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll          iiiillllPPPPaaaaggggeeee((((3333))))
  71.  
  72.  
  73.  
  74.      ggggeeeettttPPPPIIIIDDDD(((())))
  75.  
  76.           pid_t getPID()
  77.  
  78.  
  79.           Returns the process ID of the thread that computed this page.
  80.  
  81.      ggggeeeettttPPPPoooossss(((())))
  82.  
  83.           void getPos(int& x, int& y, int& z, int& c)
  84.  
  85.  
  86.           Returns the origin of this page in _x, _y, _z and _c.
  87.  
  88.      mmmmaaaattttcccchhhheeeessss(((())))
  89.  
  90.           int matches(int x, int y, int z, int c)
  91.  
  92.  
  93.           Returns TRUE if the origin of this page matches the values of _x, _y,
  94.           _z and _c.
  95.  
  96.      sssseeeettttPPPPIIIIDDDD(((())))
  97.  
  98.           void setPID()
  99.  
  100.  
  101.           Sets the process ID of the thread that computed this page.
  102.  
  103. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  104.      ilMemCacheImg
  105.  
  106.  
  107. NNNNOOOOTTTTEEEESSSS
  108.      Refer to the _I_m_a_g_e_V_i_s_i_o_n _L_i_b_a_r_y _P_r_o_g_r_a_m_m_i_n_g _G_u_i_d_e for more details.
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.